<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="LogManager,gugga.logging.LogManager,getInstance,createFilterByName,createFormatterByName,createPublisherByName,enableLogging,disableLogging,addPropertyChangeListener,removePropertyChangeListener,getDefaultPublisher,readProperties,onPropertiesRead" name="keywords">
<title>gugga.logging.LogManager</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'LogManager - API Documentation';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?gugga/logging/LogManager.html&amp;gugga/logging/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;LogManager</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class LogManager"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">gugga.logging</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class LogManager</td>
</tr>
</table>
<p></p>
 The LogManager provides a hook mechanism applications can use for loading the logging.xml file which applications can use.
 
 The global LogManager object can be retrieved using LogManager.getInstance(). 
 The LogManager object is created during class initialization and cannot subsequently be changed. 
  <p></p>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#LogManager()">LogManager</a>()</div>
<div class="summaryTableDescription">
  Private constructor.</div>
</td><td class="summaryTableOwnerCol">LogManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addPropertyChangeListener()">addPropertyChangeListener</a>(listener:<a href="events/IPropertyChangeListener.html">IPropertyChangeListener</a>):Boolean</div>
<div class="summaryTableDescription">
  Registers a property change listener with the log manager.</div>
</td><td class="summaryTableOwnerCol">LogManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#createFilterByName()">createFilterByName</a>(className:String):<a href="../logging/IFilter.html">IFilter</a>
</div>
<div class="summaryTableDescription">[static]
  Returns the Filter object associated with the class with the given string name
    </div>
</td><td class="summaryTableOwnerCol">LogManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#createFormatterByName()">createFormatterByName</a>(className:String):<a href="../logging/IFormatter.html">IFormatter</a>
</div>
<div class="summaryTableDescription">[static]
  Returns the Formatter object associated with the class with the given string name
    </div>
</td><td class="summaryTableOwnerCol">LogManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#createPublisherByName()">createPublisherByName</a>(className:String):<a href="../logging/IPublisher.html">IPublisher</a>
</div>
<div class="summaryTableDescription">[static]
  Returns the Publisher object associated with the class with the given string name
    </div>
</td><td class="summaryTableOwnerCol">LogManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#disableLogging()">disableLogging</a>():void</div>
<div class="summaryTableDescription">
  Disables logging (logging is enabled by default) for all loggers.</div>
</td><td class="summaryTableOwnerCol">LogManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#enableLogging()">enableLogging</a>():void</div>
<div class="summaryTableDescription">
  Enables logging (logging is enabled by default) for all loggers.</div>
</td><td class="summaryTableOwnerCol">LogManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getDefaultPublisher()">getDefaultPublisher</a>():<a href="../logging/IPublisher.html">IPublisher</a>
</div>
<div class="summaryTableDescription">
  Gets the default publisher, which usually will be the trace output.</div>
</td><td class="summaryTableOwnerCol">LogManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getInstance()">getInstance</a>():<a href="../logging/LogManager.html">LogManager</a>
</div>
<div class="summaryTableDescription">[static]
  Get the singleton instance.</div>
</td><td class="summaryTableOwnerCol">LogManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onPropertiesRead()">onPropertiesRead</a>():void</div>
<div class="summaryTableDescription">
  Proxy handler which will be invoked when properties are read.</div>
</td><td class="summaryTableOwnerCol">LogManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#readProperties()">readProperties</a>(propertyFile:String):void</div>
<div class="summaryTableDescription">
  Convenience method to start reading the external logging properties.</div>
</td><td class="summaryTableOwnerCol">LogManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removePropertyChangeListener()">removePropertyChangeListener</a>(listener:<a href="events/IPropertyChangeListener.html">IPropertyChangeListener</a>):Boolean</div>
<div class="summaryTableDescription">
  Unregisters a property change listener from the log manager.</div>
</td><td class="summaryTableOwnerCol">LogManager</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="LogManager()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">LogManager</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function LogManager()</code><p>
  Private constructor.
  </p></div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="addPropertyChangeListener()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addPropertyChangeListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function addPropertyChangeListener(listener:<a href="events/IPropertyChangeListener.html">IPropertyChangeListener</a>):Boolean</code><p>
  Registers a property change listener with the log manager.
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">listener</span>:<a href="events/IPropertyChangeListener.html">IPropertyChangeListener</a></code> &mdash; The listener object to be added
  </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; true if listener was added successfully, otherwise false.
  </td>
</tr>
</table>
</div>
<a name="createFilterByName()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">createFilterByName</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function createFilterByName(className:String):<a href="../logging/IFilter.html">IFilter</a></code><p>
  Returns the Filter object associated with the class with the given string name
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">className</span>:String</code> &mdash; the filter's class name 
  </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../logging/IFilter.html">IFilter</a></code> &mdash; 
                        the Filter object
  
                        
                     </td>
</tr>
</table>
</div>
<a name="createFormatterByName()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">createFormatterByName</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function createFormatterByName(className:String):<a href="../logging/IFormatter.html">IFormatter</a></code><p>
  Returns the Formatter object associated with the class with the given string name
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">className</span>:String</code> &mdash; the formatters's class name 
  </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../logging/IFormatter.html">IFormatter</a></code> &mdash; 
                        the Formatter object
  
                        
                     </td>
</tr>
</table>
</div>
<a name="createPublisherByName()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">createPublisherByName</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function createPublisherByName(className:String):<a href="../logging/IPublisher.html">IPublisher</a></code><p>
  Returns the Publisher object associated with the class with the given string name
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">className</span>:String</code> &mdash; the publishers's class name 
  </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../logging/IPublisher.html">IPublisher</a></code> &mdash; 
                        the Publisher object
  
                        
                     </td>
</tr>
</table>
</div>
<a name="disableLogging()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">disableLogging</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function disableLogging():void</code><p>
  Disables logging (logging is enabled by default) for all loggers.
  </p></div>
<a name="enableLogging()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">enableLogging</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function enableLogging():void</code><p>
  Enables logging (logging is enabled by default) for all loggers.
  </p></div>
<a name="getDefaultPublisher()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getDefaultPublisher</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getDefaultPublisher():<a href="../logging/IPublisher.html">IPublisher</a></code><p>
  Gets the default publisher, which usually will be the trace output.
    </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../logging/IPublisher.html">IPublisher</a></code> &mdash; 
                        the default publisher instance
  
                        
                     </td>
</tr>
</table>
</div>
<a name="getInstance()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getInstance</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function getInstance():<a href="../logging/LogManager.html">LogManager</a></code><p>
  Get the singleton instance.
    </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../logging/LogManager.html">LogManager</a></code> &mdash; 
                        The LogManager instance
  
                        
                     </td>
</tr>
</table>
</div>
<a name="onPropertiesRead()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onPropertiesRead</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function onPropertiesRead():void</code><p>
  Proxy handler which will be invoked when properties are read.
  It then will forward the event to all registered property change listeners. 
  </p></div>
<a name="readProperties()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">readProperties</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function readProperties(propertyFile:String):void</code><p>
  Convenience method to start reading the external logging properties.
  The method is supposed to be invoked by an application's main class on startup as part of the hook mechanism.
  Make sure you have registered a listener before in order to proceed.
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">propertyFile</span>:String</code> &mdash; A file location which contains logging properties 
  </td>
</tr>
</table>
</div>
<a name="removePropertyChangeListener()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removePropertyChangeListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function removePropertyChangeListener(listener:<a href="events/IPropertyChangeListener.html">IPropertyChangeListener</a>):Boolean</code><p>
  Unregisters a property change listener from the log manager.
    </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">listener</span>:<a href="events/IPropertyChangeListener.html">IPropertyChangeListener</a></code> &mdash; listener object to be removed
  </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; true if listener was actually removed, otherwise false.
  </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
